package grabana

Import Path
	github.com/K-Phoen/grabana (on go.dev)

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	    alerts.go
	    apikeys.go
	    client.go
	    dashboards.go
	    datasources.go
	  d doc.go
		Package grabana provides a developer-friendly way of creating Grafana dashboards.
		
		Whether you prefer writing **code or YAML**, if you are looking for a way to
		version your dashboards configuration or automate tedious and error-prone
		creation of dashboards, this library is meant for you.
		
			builder := dashboard.New(
				"Awesome dashboard",
				dashboard.VariableAsInterval(
					"interval",
					interval.Values([]string{"30s", "1m", "5m", "10m", "30m", "1h", "6h", "12h"}),
				),
				dashboard.VariableAsQuery(
					"status",
					query.DataSource("prometheus-default"),
					query.Request("label_values(prometheus_http_requests_total, code)"),
					query.Sort(query.NumericalAsc),
				),
				dashboard.Row(
					"Prometheus",
					row.WithTimeSeries(
						"HTTP Rate",
						timeseries.WithPrometheusTarget(
							"rate(promhttp_metric_handler_requests_total[$interval])",
							prometheus.Legend("{{handler}} - {{ code }}"),
						),
					),
					row.WithTable(
						"Threads",
						table.WithPrometheusTarget("go_threads"),
						table.HideColumn("Time"),
						table.AsTimeSeriesAggregations([]table.Aggregation{
							{Label: "AVG", Type: table.AVG},
							{Label: "Current", Type: table.Current},
						}),
					),
					row.WithStat(
						"Heap Allocations",
						stat.Unit("bytes"),
						stat.WithPrometheusTarget("go_memstats_heap_alloc_bytes"),
					),
				),
				dashboard.Row(
					"Some text, because it might be useful",
					row.WithText(
						"Some awesome html?",
						text.HTML("<b>lalalala</b>"),
					),
				),
			)
		
		For a more information visit https://github.com/K-Phoen/grabana

	    folders.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type APIKey (struct)
		APIKey represents an API key.

		Fields (total 2)
			ID uint
			Name string
		As Outputs Of (at least one exported)
			func (*Client).APIKeys(ctx context.Context) (map[string]APIKey, error)

	 type APIKeyRole uint8 (basic type)
		APIKeyRole represents a role given to an API key.

		Methods (only one)
			( APIKeyRole) MarshalJSON() ([]byte, error)
		Implements (at least 2)
			 APIKeyRole : github.com/goccy/go-json.Marshaler
			 APIKeyRole : encoding/json.Marshaler
		As Types Of (total 3)
			const AdminRole
			const EditorRole
			const ViewerRole

	 type Client (struct)
		Client represents a Grafana HTTP client.

		Methods (total 15)
			(*Client) APIKeys(ctx context.Context) (map[string]APIKey, error)
				APIKeys lists active API keys.

			(*Client) AddAlert(ctx context.Context, namespace string, alertDefinition alert.Alert, datasourcesMap map[string]string) error
				AddAlert creates an alert group within a given namespace.

			(*Client) ConfigureAlertManager(ctx context.Context, manager *alertmanager.Manager) error
				ConfigureAlertManager updates the alert manager configuration.

			(*Client) CreateAPIKey(ctx context.Context, request CreateAPIKeyRequest) (string, error)
				CreateAPIKey creates a new API key.

			(*Client) CreateFolder(ctx context.Context, name string) (*Folder, error)
				CreateFolder creates a dashboard folder.
				See https://grafana.com/docs/grafana/latest/reference/dashboard_folders/

			(*Client) DeleteAPIKeyByName(ctx context.Context, name string) error
				DeleteAPIKeyByName deletes an API key given its name.

			(*Client) DeleteAlertGroup(ctx context.Context, namespace string, groupName string) error
				DeleteAlertGroup deletes an alert group.

			(*Client) DeleteDashboard(ctx context.Context, uid string) error
				DeleteDashboard deletes a dashboard given its UID.

			(*Client) DeleteDatasource(ctx context.Context, name string) error
				DeleteDatasource deletes a datasource given its name.

			(*Client) FindOrCreateFolder(ctx context.Context, name string) (*Folder, error)
				FindOrCreateFolder returns the folder by its name or creates it if it doesn't exist.

			(*Client) GetDashboardByTitle(ctx context.Context, title string) (*Dashboard, error)
				GetDashboardByTitle finds a dashboard, given its title.

			(*Client) GetDatasourceUIDByName(ctx context.Context, name string) (string, error)
				GetDatasourceUIDByName finds a datasource UID given its name.

			(*Client) GetFolderByTitle(ctx context.Context, title string) (*Folder, error)
				GetFolderByTitle finds a folder, given its title.

			(*Client) UpsertDashboard(ctx context.Context, folder *Folder, builder dashboard.Builder) (*Dashboard, error)
				UpsertDashboard creates or replaces a dashboard, in the given folder.

			(*Client) UpsertDatasource(ctx context.Context, datasource datasource.Datasource) error
				UpsertDatasource creates or replaces a datasource.

		As Outputs Of (at least one exported)
			func NewClient(http *http.Client, host string, options ...Option) *Client

	 type CreateAPIKeyRequest (struct)
		CreateAPIKeyRequest represents a request made to the API key creation endpoint.

		Fields (total 3)
			Name string
			Role APIKeyRole
			SecondsToLive int
		As Inputs Of (at least one exported)
			func (*Client).CreateAPIKey(ctx context.Context, request CreateAPIKeyRequest) (string, error)

	 type Dashboard (struct)
		Dashboard represents a Grafana dashboard.

		Fields (total 10)
			FolderID int
			FolderTitle string
			FolderUID string
			FolderURL string
			ID int
			IsStarred bool
			Tags []string
			Title string
			UID string
			URL string
		As Outputs Of (at least 2)
			func (*Client).GetDashboardByTitle(ctx context.Context, title string) (*Dashboard, error)
			func (*Client).UpsertDashboard(ctx context.Context, folder *Folder, builder dashboard.Builder) (*Dashboard, error)

	 type Folder (struct)
		Folder represents a dashboard folder.
		See https://grafana.com/docs/grafana/latest/reference/dashboard_folders/

		Fields (total 4)
			ID uint
			ParentUID string
			Title string
			UID string
		As Outputs Of (at least 3)
			func (*Client).CreateFolder(ctx context.Context, name string) (*Folder, error)
			func (*Client).FindOrCreateFolder(ctx context.Context, name string) (*Folder, error)
			func (*Client).GetFolderByTitle(ctx context.Context, title string) (*Folder, error)
		As Inputs Of (at least one exported)
			func (*Client).UpsertDashboard(ctx context.Context, folder *Folder, builder dashboard.Builder) (*Dashboard, error)

	 type Option (func)
		Option represents an option that can be used to configure a client.

		As Outputs Of (at least 2)
			func WithAPIToken(token string) Option
			func WithBasicAuth(username string, password string) Option
		As Inputs Of (at least one exported)
			func NewClient(http *http.Client, host string, options ...Option) *Client


Package-Level Functions (total 3)

	 func NewClient(http *http.Client, host string, options ...Option) *Client
		NewClient creates a new Grafana HTTP client, using an API token.

	 func WithAPIToken(token string) Option
		WithAPIToken sets up the client to use the given token to authenticate.

	 func WithBasicAuth(username string, password string) Option
		WithBasicAuth sets up the client to use the given credentials to authenticate.


Package-Level Variables (total 5)

	  var ErrAlertNotFound error
		ErrAlertNotFound is returned when the requested alert can not be found.

	  var ErrAPIKeyNotFound error
		ErrAPIKeyNotFound is returned when the given API key can not be found.

	  var ErrDashboardNotFound error
		ErrDashboardNotFound is returned when the given dashboard can not be found.

	  var ErrDatasourceNotFound error
		ErrDatasourceNotFound is returned when the given datasource can not be found.

	  var ErrFolderNotFound error
		ErrFolderNotFound is returned when the given folder can not be found.


Package-Level Constants (total 3)

	const AdminRole APIKeyRole = 0
	const EditorRole APIKeyRole = 1
	const ViewerRole APIKeyRole = 2

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.